Network Support Library/RoseWare - Network Support Library.iso/apidev/tpapi.exe/NWPRINT.PA1

Text File | 1994-01-14 | 9KB | 221 lines

{#Z+}
(*(10U&l12D(s4099T&k2S*)
{***************************************************************************}
{** Program : NWPRINT                                                     **}
{***************************************************************************}
{** Version : 1.53            ** Started : 11/11/91  ** Ended :   /  /    **}
{***************************************************************************}
{******************************** Description ******************************}
{***************************************************************************}
{** OOP library for Netware API                                           **}
{**                                                                       **}
{** This unit forms the second level object : PRINT                       **}
{** This object is a descandent of          : NETWARE                     **}
{**                                                                       **}
{**                                                                       **}
{**                                                                       **}
{**                                                                       **}
{***************************************************************************}
{******************************** Information ******************************}
{***************************************************************************}
{** Provides Netware Printint Services                                    **}
{**                                                                       **}
{**                                                                       **}
{**                                                                       **}
{** This code is (c) 1991 - 1994 Antonio Covelli. ALL RIGHTS RESERVED.    **}
{** Portions (c) Novell Inc,                                              **}
{**                                                                       **}
{**                                                                       **}
{***************************************************************************}

{$I NETWARE.INC}
{#Z-}

UNIT NWPRINT;

INTERFACE

USES

  nwvar,
  netware;

TYPE

  PPrintOBJ = ^PrintOBJ;
  PrintOBJ  = OBJECT (NetwareOBJ)

    { This object provides Netware Printing Services API's. }

    FUNCTION CancelLPTCapture : WORD;
    { Cancels the redirection of the default LPT device. }

    FUNCTION CancelSpecificLPTCapture (LPTDevice : BYTE) : WORD;
    { Cancels the redirection of the specified LPT device. }
    {#F}
    {}
    { LPTDevice: 00h = LPT1 }
    {            01h = LPT2 }
    {            02h = LPT3 }
    {#F}

    FUNCTION ENDLPTCapture : WORD;
    { Ends the redirection of the default LPT device. The print job will then
      be serviced by the print server. }

    FUNCTION ENDSpecificLPTCapture (LPTDevice : BYTE) : WORD;
    { Ends the redirection of the specified LPT device. The print job will then
      be serviced by the print server. }
    {#F}
    {}
    { LPTDevice: 00h = LPT1 }
    {            01h = LPT2 }
    {            02h = LPT3 }
    {#F}

    FUNCTION FlushLPTCapture : WORD;
    { Flushes the data sent to the default LPT device. The print job will then
      be serviced by the print server. The LPT device remains spooled and any
      new data sent to the device will cause the creation of a new spool file. }

    FUNCTION FlushSpecificLPTCapture (LPTDevice : BYTE) : WORD;
    { Flushes the data sent to the specified LPT device. The print job will then
      be serviced by the print server. The LPT device remains spooled and any
      new data sent to the device will cause the creation of a new spool file. }
    {#F}
    {}
    { LPTDevice: 00h = LPT1 }
    {            01h = LPT2 }
    {            02h = LPT3 }
    {#F}

    FUNCTION GetBannerUserName (var BannerUserName : TBannerUserName) : WORD;
    { Returns the name that will appear on the banner page of print jobs. }
    {#F}
    {}
    { BannerUserName: current name that appears on the banner page of jobs. }
    {#F}

    FUNCTION GetSpecificCaptureFlags (LPTDevice : BYTE;
                                      VAR CaptureFlags : Capture_Flags) : WORD;

    FUNCTION GetDefaultCaptureFlags   (VAR CaptureFlags : Capture_Flags) : WORD;

    FUNCTION GetDefaultLocalPrinter : BYTE;
    { Returns the default LPT device: }
    {#F}
    {}
    { LPTDevice: 00h = LPT1 }
    {            01h = LPT2 }
    {            02h = LPT3 }
    {#F}

    FUNCTION GetLPTCaptureStatus (VAR LPTServerNumber : BYTE) : WORD;
    { This call returns the status of the default LPT device. }
    {#F}
    {}
    { LPTServerNumber: contains the connection id of the queueing server. }
    {#F}

    FUNCTION GetPrinterQueue (PrinterNumber : BYTE;
                              VAR QueueID : OT_BinderyID) : WORD;
    { Returns the print queue ID associated with the printer number on a file
      server. }
    {#F}
    {}
    { PrinterNumber: number of printer to retrieve assigned print queue. }
    { QueueID      : Object ID of the print queue assigned to the specified
                printer number. }
    {#F}

    FUNCTION GetPrinterStatus (TargetNumber : BYTE; VAR PrinterHalted,
                               PrinterOffLine, FormType,
                               RedirectedPrinter : BYTE) : WORD;
    { Allows a client to check the status of a shared printer. }
    {#F}
    {}
    { TargetPrinter     : number of printer to get status for. }
    { PrinterHalted     : $FF = printer halted   $00 = printer running. }
    { PrinterOffline    : $FF = printer offline  $00 = printer online. }
    { FormType          : contains the number of the form currently mounted. }
    { RedirectedPrinter : should be the same as TargetPrinter. If different the
                     console has redirected print jobs to this printer. }
    {#F}

    FUNCTION GetPrinterStatus2 (TargetNumber : BYTE; VAR PrinterHalted,
                                PrinterOffLine, FormType,
                                RedirectedPrinter : BYTE) : WORD;
    { Allows a client to check the status of a shared printer. }
    {#F}
    {}
    { TargetPrinter     : number of printer to get status for. }
    { PrinterHalted     : $FF = printer halted  $00 = printer running. }
    { PrinterOffline    : $FF = printer offline $00 = printer online. }
    { FormType          : contains the number of the form currently mounted. }
    { RedirectedPrinter : should be the same as TargetPrinter. If different the
                     console has redirected print jobs to this printer. }
    {#F}

    FUNCTION SetBannerUserName (BannerUserName : TBannerUserName) : WORD;
    { Sets the name that will appear on the banner page of print jobs. }
    {#F}
    {}
    { BannerUserName: new name that will appear on the banner page of jobs. }
    {#F}

    FUNCTION SetCapturePrintJob (LPTDevice : BYTE; JobNumber : WORD;
                                 VAR JobFileHandle) : WORD;

    FUNCTION SetCapturePrintQueue (LPTDevice : BYTE; ConnectionID : WORD;
                                   QueueID : OT_BinderyID) : WORD;

    FUNCTION SetDefaultCaptureFlags (CaptureFlags : Capture_Flags) : WORD;

    FUNCTION SetDefaultLocalPrinter (LPTDevice : BYTE) : WORD;
    { Sets the default LPT device:}
    {#F}
    {}
    { LPTDevice: 00h = LPT1 }
    {            01h = LPT2 }
    {            02h = LPT3 }
    {#F}

    FUNCTION SetCaptureFlags (LPTDevice : BYTE;
                              CaptureFlags : Capture_Flags) : WORD;

    FUNCTION SetSpoolFlags (PrintFlags : BYTE; TabSize, PrinterNumber,
                            NumberOfCopies, FormType : WORD;
                            BannerUserName : TBannerUserName) : WORD;

    FUNCTION SpecifyCaptureFile (DirectoryHandle : BYTE;
                                 FilePath : TPathName) : WORD;
    { Allows an application to send data directly to a permanent file residing
      on a fileserver. When using this call DO NOT set any Capture settings.}
    {#F}
    {}
    { DirectoryHandle: Directory handle pointing to a directory/volume. If
                  specifying a full path then should be 0. }
    { FilePath       : Path where the file should be created. Must include the
                  filename. If DirectoryHandle is 0 then FilePath must include
                  the volume name. eg. SYS1:\USERS\TONY\TEST.PRT. }
    {#F}

    FUNCTION StartLPTCapture : WORD;
    { Redirects the default LPT device to either a print queue or a permanent
      data file depending on the Capture Flags. }

    FUNCTION StartSpecificLPTCapture (LPTDevice : BYTE) : WORD;
    { Redirects the specified LPT device to either a print queue or a permanent
      data file depending on the Capture Flags. }
    {#F}
    {}
    { LPTDevice: 00h = LPT1 }
    {            01h = LPT2 }
    {            02h = LPT3 }
    {#F}

    DESTRUCTOR  Done; VIRTUAL;

  END;